StringScanner.GotoLineStart Function

Syntax

Offset as N = GotoLineStart as N(lineNumber as N)

Arguments

Offset: A new scanner object that supports operations against Text.
lineNumber: The text that you want to process

Description

Set the offset to the first character of the specified line, returns offset (returns 0 if line number doesn't exist).

Discussion

The <StringScanner>.GotoLineStart() function sets the offset to the beginning of the specified line and returns the offset value.

Example

dim scanner as StringScanner
dim txt as C
txt = <<%text%
This is line one
and this is line two
and finally line three
%text%
scanner = stringscanner.Create(txt)
? scanner.GotoLineStart(3)
= 40